home *** CD-ROM | disk | FTP | other *** search
/ MacFormat 1994 December / macformat-019.iso / Shareware City / Developers / Gnuplot 3.5 for Macintosh / docs / README < prev    next >
Encoding:
Text File  |  1993-11-03  |  3.8 KB  |  108 lines  |  [TEXT/MSWD]
  1. Notes on the gnuplot help files and documentation.
  2.  
  3. Gnuplot documentation is available in three ways:
  4.  
  5. 1 - interactively, within gnuplot
  6. 2 - as a printed document. 
  7. 3 - as a manual page, through the Unix man(1) facility
  8.  
  9. The first two forms describe the inner workings, and contain
  10. equivalent information, while the third form tells how to run gnuplot.
  11.  
  12. The two first forms above derive their information from the file
  13. gnuplot.doc, which is the MASTER copy of gnuplot help information. All
  14. other forms, except for gnuplot.1, the man page, are derived from it. 
  15.  
  16. gnuplot.doc -> gnuplot.hlp 
  17.             -> gnuplot.gih
  18.             -> gnuplot.tex
  19.             -> gnuplot.ms
  20.             -> gnuplot.rtf
  21.                                       
  22. On VMS the interactive help is supplied by the system help facility,
  23. using the gnuplot.hlp file. This is made with ('make hlp').  On Unix,
  24. AmigaDOS, and MSDOS the interactive help is built in to the program,
  25. and uses the gnuplot.gih file ('make gih').  On MS-Windows, the
  26. Microsoft help compiler converts an 'rtf' file to an 'hlp' file 
  27. which is used by the standard Windows help program.
  28.  
  29. The printed document is available in either latex or troff/nroff (ms)
  30. format, using gnuplot.tex or gnuplot.ms, derived from gnuplot.doc with
  31. either doc2tex or doc2ms. Type 'make dvi' or 'make nroff'. For troff,
  32. type 'make ms' and then troff -ms gnuplot.ms in whatever way you use
  33. troff.
  34.  
  35. If VMS users prefer the gnuplot interactive help facility to the
  36. system facility, this can be easily changed in command.c.
  37.  
  38.  
  39. Description of the gnuplot.doc format:
  40. --------------------------------------
  41.  
  42. Here is an example of the DOC master help format:
  43.  
  44. ?
  45. 1 gnuplot
  46.  GNUPLOT is a command-driven interactive function plotting program.  It
  47.  ...
  48. ?exit
  49. 2 exit
  50.  'exit', 'quit' and ...
  51. ?expressions
  52. 2 expressions
  53.  In general, any mathematical expression accepted by C, ...
  54.  
  55.  Topics:
  56.  functions operators
  57. ?expressions functions
  58. ?functions
  59. 3 functions
  60.  The functions in GNUPLOT are ...
  61.  
  62.  Topics:
  63.  abs acos arg ...
  64. ?expressions functions abs
  65. ?functions abs
  66. ?abs
  67. 4 abs
  68.  This function returns the absolute value of its argument.  The
  69.  returned value is of the same type as the argument. 
  70. ?expressions functions acos
  71. ?functions acos
  72. ?acos
  73. 4 acos
  74.  This function returns the arc cosine (inverse cosine) of its
  75.  argument.  'acos' returns its argument in radians. 
  76.  
  77.  
  78. Some notes about the format:
  79. ----------------------------
  80. Remember that all text must be able to be processed by gnuplot, VMS,
  81.  nroff, troff, and latex, and always do something reasonable. 
  82. The first column is reserved for control characters.
  83. Text does not start in the first column.
  84. Lines that start in column 2 may be typeset by LaTeX.
  85. Lines that have a space in column 2 are to be printed in a verbatim
  86.  environment by LaTeX.
  87. Tables must have a space in column 2.
  88. Do NOT use tabs in the help file.
  89. Conversion from this format to vax .hlp file involves removal of
  90.  lines starting with [?@#$%] (see doc2hlp). VMS uses the numbers
  91.  to represent a tree. 
  92. Conversion from this format to gnuplot .gih file involves removal of
  93.  lines starting with [0-9@#$%] (see doc2gih). Gnuplot matches your
  94.  help query against the ? lines to find the help information.
  95.  Multiple ? lines for one text block constitute synonyms. The most
  96.  specific should be first, eg 'expressions functions' before 'functions'.
  97.  Spaces are allowed here, but should be single.
  98. Backquote pairs are converted by the doc2tex program into boldface;
  99.  that is, `some text` is converted to {\bf some text}. Be sure to pair
  100.  the backquotes, or the whole document will be boldface!
  101.  
  102. Control characters in first column:
  103. ?    used by .gih format, for builtin interactive help - keyword
  104. 0-9  used by VMS help and by doc2{tex,ms} formatters to define level,keyword
  105. @    used by doc2{tex,ms} to define table start/end
  106. #    used by doc2tex: table entry
  107. %    used by doc2ms: table entry
  108.